<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::Future&lt; T &gt; Class Template Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('dc/d14/classBloomberg_1_1quantum_1_1Future.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d8/d7e/classBloomberg_1_1quantum_1_1Future-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::Future&lt; T &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class representing a promised future. Can only be instantiated via a <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value.">Promise</a> object.  
 <a href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../df/d72/quantum__icoro__future_8h_source.html">quantum_icoro_future.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bloomberg::quantum::Future&lt; T &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../dc/d14/classBloomberg_1_1quantum_1_1Future.png" usemap="#Bloomberg::quantum::Future_3C_20T_20_3E_map" alt=""/>
  <map id="Bloomberg::quantum::Future_3C_20T_20_3E_map" name="Bloomberg::quantum::Future_3C_20T_20_3E_map">
<area href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html" alt="Bloomberg::quantum::IThreadFuture&lt; T &gt;" shape="rect" coords="0,56,241,80"/>
<area href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html" title="Exposes methods to access a coroutine-compatible future." alt="Bloomberg::quantum::ICoroFuture&lt; T &gt;" shape="rect" coords="251,56,492,80"/>
<area href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html" alt="Bloomberg::quantum::IThreadFutureBase" shape="rect" coords="0,0,241,24"/>
<area href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html" title="Exposes methods to access a coroutine-compatible future." alt="Bloomberg::quantum::ICoroFutureBase" shape="rect" coords="251,0,492,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a89190725c7965a1114b1c55f2e4af9c3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a89190725c7965a1114b1c55f2e4af9c3">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt; T &gt; &gt;</td></tr>
<tr class="separator:a89190725c7965a1114b1c55f2e4af9c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1IThreadFuture')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html">Bloomberg::quantum::IThreadFuture&lt; T &gt;</a></td></tr>
<tr class="memitem:a8a293fb67a050a3ff6f978ffa86c3f1c inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a8a293fb67a050a3ff6f978ffa86c3f1c">ContextTag</a> = <a class="el" href="../../de/de9/structBloomberg_1_1quantum_1_1ThreadContextTag.html">ThreadContextTag</a></td></tr>
<tr class="separator:a8a293fb67a050a3ff6f978ffa86c3f1c inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac374cb79ae4bc8b192033c1b8aebf5cd inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#ac374cb79ae4bc8b192033c1b8aebf5cd">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html">IThreadFuture</a>&lt; T &gt; &gt;</td></tr>
<tr class="separator:ac374cb79ae4bc8b192033c1b8aebf5cd inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c10ac67437e42c08fd4be6cc7d9c1fe inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a5c10ac67437e42c08fd4be6cc7d9c1fe">Impl</a> = <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt; T &gt;</td></tr>
<tr class="separator:a5c10ac67437e42c08fd4be6cc7d9c1fe inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1IThreadFutureBase')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">Bloomberg::quantum::IThreadFutureBase</a></td></tr>
<tr class="memitem:a7a5e5adf9e104bef3f570aace79ecf5c inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a7a5e5adf9e104bef3f570aace79ecf5c">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">IThreadFutureBase</a> &gt;</td></tr>
<tr class="separator:a7a5e5adf9e104bef3f570aace79ecf5c inherit pub_types_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1ICoroFuture')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html">Bloomberg::quantum::ICoroFuture&lt; T &gt;</a></td></tr>
<tr class="memitem:af3d243d85fa43cc6256d637fdbbe74c8 inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#af3d243d85fa43cc6256d637fdbbe74c8">ContextTag</a> = <a class="el" href="../../dd/d45/structBloomberg_1_1quantum_1_1CoroContextTag.html">CoroContextTag</a></td></tr>
<tr class="separator:af3d243d85fa43cc6256d637fdbbe74c8 inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af79854523a3ab9e3aaa6bc8bdcebf7cd inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#af79854523a3ab9e3aaa6bc8bdcebf7cd">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html">ICoroFuture</a>&lt; T &gt; &gt;</td></tr>
<tr class="separator:af79854523a3ab9e3aaa6bc8bdcebf7cd inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e695ecf3265555848015e41ceb6726b inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#a7e695ecf3265555848015e41ceb6726b">Impl</a> = <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt; T &gt;</td></tr>
<tr class="separator:a7e695ecf3265555848015e41ceb6726b inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structBloomberg_1_1quantum_1_1ICoroFutureBase')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html">Bloomberg::quantum::ICoroFutureBase</a></td></tr>
<tr class="memitem:a8fdb9918c64ffca16815929757df77fe inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#a8fdb9918c64ffca16815929757df77fe">Ptr</a> = std::shared_ptr&lt; <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html">ICoroFutureBase</a> &gt;</td></tr>
<tr class="separator:a8fdb9918c64ffca16815929757df77fe inherit pub_types_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a43a6a326981dd3899bba8f6483fe5e96"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a43a6a326981dd3899bba8f6483fe5e96">Future</a> ()=default</td></tr>
<tr class="separator:a43a6a326981dd3899bba8f6483fe5e96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2160d4fb8675845b45923cacfc65e016"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a2160d4fb8675845b45923cacfc65e016">valid</a> () const final</td></tr>
<tr class="memdesc:a2160d4fb8675845b45923cacfc65e016"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if this future still has a shared state with the corresponding promise object.  <a href="#a2160d4fb8675845b45923cacfc65e016">More...</a><br /></td></tr>
<tr class="separator:a2160d4fb8675845b45923cacfc65e016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb3a83f94187b49c6f142379b0ce0d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a2bb3a83f94187b49c6f142379b0ce0d7">wait</a> () const final</td></tr>
<tr class="memdesc:a2bb3a83f94187b49c6f142379b0ce0d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value.  <a href="#a2bb3a83f94187b49c6f142379b0ce0d7">More...</a><br /></td></tr>
<tr class="separator:a2bb3a83f94187b49c6f142379b0ce0d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e602a8b6fa2df3fbac6b807bb1351fb"><td class="memItemLeft" align="right" valign="top">std::future_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a6e602a8b6fa2df3fbac6b807bb1351fb">waitFor</a> (std::chrono::milliseconds timeMs) const final</td></tr>
<tr class="memdesc:a6e602a8b6fa2df3fbac6b807bb1351fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value up to a maximum 'timeMs' milliseconds.  <a href="#a6e602a8b6fa2df3fbac6b807bb1351fb">More...</a><br /></td></tr>
<tr class="separator:a6e602a8b6fa2df3fbac6b807bb1351fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c06b883abff66d8bee4e354bc864fd"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:ac7c06b883abff66d8bee4e354bc864fd"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#ac7c06b883abff66d8bee4e354bc864fd">get</a> ()</td></tr>
<tr class="separator:ac7c06b883abff66d8bee4e354bc864fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4737242e21d49129b664fe6fba27edd3"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a4737242e21d49129b664fe6fba27edd3"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a4737242e21d49129b664fe6fba27edd3">getRef</a> () const</td></tr>
<tr class="separator:a4737242e21d49129b664fe6fba27edd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a546ee39f9b5b6614497835998a7c9ed2"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a546ee39f9b5b6614497835998a7c9ed2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a3e3f89ff8206c0514976b423cb7199cd">BufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a546ee39f9b5b6614497835998a7c9ed2">pull</a> (bool &amp;isBufferClosed)</td></tr>
<tr class="separator:a546ee39f9b5b6614497835998a7c9ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31f48375fda5b97a9287865f6ae55319"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a31f48375fda5b97a9287865f6ae55319">wait</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync) const final</td></tr>
<tr class="memdesc:a31f48375fda5b97a9287865f6ae55319"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value.  <a href="#a31f48375fda5b97a9287865f6ae55319">More...</a><br /></td></tr>
<tr class="separator:a31f48375fda5b97a9287865f6ae55319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2674f2183419f724622a6a3ef27fa7b8"><td class="memItemLeft" align="right" valign="top">std::future_status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a2674f2183419f724622a6a3ef27fa7b8">waitFor</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync, std::chrono::milliseconds timeMs) const final</td></tr>
<tr class="memdesc:a2674f2183419f724622a6a3ef27fa7b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for the future value up to a maximum 'timeMs' milliseconds.  <a href="#a2674f2183419f724622a6a3ef27fa7b8">More...</a><br /></td></tr>
<tr class="separator:a2674f2183419f724622a6a3ef27fa7b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dfc4941520cc02fd5ba73e7da65aa9f"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a5dfc4941520cc02fd5ba73e7da65aa9f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a5dfc4941520cc02fd5ba73e7da65aa9f">get</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync)</td></tr>
<tr class="memdesc:a5dfc4941520cc02fd5ba73e7da65aa9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the future value.  <a href="#a5dfc4941520cc02fd5ba73e7da65aa9f">More...</a><br /></td></tr>
<tr class="separator:a5dfc4941520cc02fd5ba73e7da65aa9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32ca82d86eedf44d119499dd87e0d7e0"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a32ca82d86eedf44d119499dd87e0d7e0"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a32ca82d86eedf44d119499dd87e0d7e0">getRef</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync) const</td></tr>
<tr class="memdesc:a32ca82d86eedf44d119499dd87e0d7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a reference the future value.  <a href="#a32ca82d86eedf44d119499dd87e0d7e0">More...</a><br /></td></tr>
<tr class="separator:a32ca82d86eedf44d119499dd87e0d7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50bcfe54894b9afe5c944eaeb34969bd"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a50bcfe54894b9afe5c944eaeb34969bd"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a3e3f89ff8206c0514976b423cb7199cd">BufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a50bcfe54894b9afe5c944eaeb34969bd">pull</a> (<a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a> sync, bool &amp;isBufferClosed)</td></tr>
<tr class="memdesc:a50bcfe54894b9afe5c944eaeb34969bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pull a single value from the future buffer.  <a href="#a50bcfe54894b9afe5c944eaeb34969bd">More...</a><br /></td></tr>
<tr class="separator:a50bcfe54894b9afe5c944eaeb34969bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html">Bloomberg::quantum::IThreadFuture&lt; T &gt;</a></td></tr>
<tr class="memitem:a9e5f5175525b7552ff796d6b4ae92d4d inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a9e5f5175525b7552ff796d6b4ae92d4d inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a9e5f5175525b7552ff796d6b4ae92d4d">get</a> ()</td></tr>
<tr class="memdesc:a9e5f5175525b7552ff796d6b4ae92d4d inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the future value.  <a href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a9e5f5175525b7552ff796d6b4ae92d4d">More...</a><br /></td></tr>
<tr class="separator:a9e5f5175525b7552ff796d6b4ae92d4d inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a654c60b1f95b6daa3adaa4d0d5c4f22e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:a654c60b1f95b6daa3adaa4d0d5c4f22e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a654c60b1f95b6daa3adaa4d0d5c4f22e">getRef</a> () const</td></tr>
<tr class="memdesc:a654c60b1f95b6daa3adaa4d0d5c4f22e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a reference the future value.  <a href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#a654c60b1f95b6daa3adaa4d0d5c4f22e">More...</a><br /></td></tr>
<tr class="separator:a654c60b1f95b6daa3adaa4d0d5c4f22e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5ee4328e6105cf062a76ef7268b7d3e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplParams" colspan="2">template&lt;class V  = T&gt; </td></tr>
<tr class="memitem:af5ee4328e6105cf062a76ef7268b7d3e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a3e3f89ff8206c0514976b423cb7199cd">BufferRetType</a>&lt; V &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#af5ee4328e6105cf062a76ef7268b7d3e">pull</a> (bool &amp;isBufferClosed)</td></tr>
<tr class="memdesc:af5ee4328e6105cf062a76ef7268b7d3e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pull a single value from the future buffer.  <a href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html#af5ee4328e6105cf062a76ef7268b7d3e">More...</a><br /></td></tr>
<tr class="separator:af5ee4328e6105cf062a76ef7268b7d3e inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFuture"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structBloomberg_1_1quantum_1_1IThreadFutureBase')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html">Bloomberg::quantum::IThreadFutureBase</a></td></tr>
<tr class="memitem:a934b37ec3fc8f57406fbca24cc90c40a inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a934b37ec3fc8f57406fbca24cc90c40a">~IThreadFutureBase</a> ()=default</td></tr>
<tr class="memdesc:a934b37ec3fc8f57406fbca24cc90c40a inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a934b37ec3fc8f57406fbca24cc90c40a">More...</a><br /></td></tr>
<tr class="separator:a934b37ec3fc8f57406fbca24cc90c40a inherit pub_methods_structBloomberg_1_1quantum_1_1IThreadFutureBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structBloomberg_1_1quantum_1_1ICoroFutureBase')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html">Bloomberg::quantum::ICoroFutureBase</a></td></tr>
<tr class="memitem:ac320a032b464b1578a67492dc78bd299 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#ac320a032b464b1578a67492dc78bd299">~ICoroFutureBase</a> ()=default</td></tr>
<tr class="memdesc:ac320a032b464b1578a67492dc78bd299 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#ac320a032b464b1578a67492dc78bd299">More...</a><br /></td></tr>
<tr class="separator:ac320a032b464b1578a67492dc78bd299 inherit pub_methods_structBloomberg_1_1quantum_1_1ICoroFutureBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a43e7b3add532f39f40e713c0c53ad53b"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a43e7b3add532f39f40e713c0c53ad53b">operator new</a> (size_t size)</td></tr>
<tr class="separator:a43e7b3add532f39f40e713c0c53ad53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a108343143f6e66344798da1bf36609f9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a108343143f6e66344798da1bf36609f9">operator delete</a> (void *p)</td></tr>
<tr class="separator:a108343143f6e66344798da1bf36609f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad55409916f379a130a73612f5590543"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#aad55409916f379a130a73612f5590543">deleter</a> (<a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt; T &gt; *p)</td></tr>
<tr class="separator:aad55409916f379a130a73612f5590543"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a38b7a1d0cb5a6365a03c19b76293e519"><td class="memTemplParams" colspan="2">template&lt;class F &gt; </td></tr>
<tr class="memitem:a38b7a1d0cb5a6365a03c19b76293e519"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="../../d9/d6d/classclass.html">class</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#a38b7a1d0cb5a6365a03c19b76293e519">Promise</a></td></tr>
<tr class="separator:a38b7a1d0cb5a6365a03c19b76293e519"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class Bloomberg::quantum::Future&lt; T &gt;</h3>

<p>Class representing a promised future. Can only be instantiated via a <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value.">Promise</a> object. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of value returned by the future object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>See <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1IThreadFuture.html">IThreadFuture</a> and <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html" title="Exposes methods to access a coroutine-compatible future.">ICoroFuture</a> interfaces for usage details. An instance of this class can only be obtained via a <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value.">Promise</a> object and cannot be created on its own. </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a89190725c7965a1114b1c55f2e4af9c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89190725c7965a1114b1c55f2e4af9c3">&#9670;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::<a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#af79854523a3ab9e3aaa6bc8bdcebf7cd">Ptr</a> =  std::shared_ptr&lt;<a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt;T&gt; &gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a43a6a326981dd3899bba8f6483fe5e96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43a6a326981dd3899bba8f6483fe5e96">&#9670;&nbsp;</a></span>Future()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::<a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aad55409916f379a130a73612f5590543"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad55409916f379a130a73612f5590543">&#9670;&nbsp;</a></span>deleter()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::deleter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a>&lt; T &gt; *&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ac7c06b883abff66d8bee4e354bc864fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c06b883abff66d8bee4e354bc864fd">&#9670;&nbsp;</a></span>get() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::get </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a5dfc4941520cc02fd5ba73e7da65aa9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dfc4941520cc02fd5ba73e7da65aa9f">&#9670;&nbsp;</a></span>get() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the future value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The future value. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the future is ready or until an exception is thrown. Once this function returns, the future becomes invalidated (i.e. cannot be read again) </dd></dl>

<p>Implements <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#a9b5cd81cf5aa3eb4698177dbfbea78c4">Bloomberg::quantum::ICoroFuture&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a4737242e21d49129b664fe6fba27edd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4737242e21d49129b664fe6fba27edd3">&#9670;&nbsp;</a></span>getRef() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; &amp; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::getRef </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a32ca82d86eedf44d119499dd87e0d7e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32ca82d86eedf44d119499dd87e0d7e0">&#9670;&nbsp;</a></span>getRef() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a0a7dd2b5f475bbecb11bfa87fcc251c5">NonBufferRetType</a>&lt; V &gt; &amp; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::getRef </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a reference the future value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the future value. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the future is ready or until an exception is thrown. Contrary to <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html#ac7c06b883abff66d8bee4e354bc864fd">get()</a>, this function does not invalidate the future and as such may be read again. </dd></dl>

<p>Implements <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#ad5dad6537c8cc9e35e1a3a273cdfb7aa">Bloomberg::quantum::ICoroFuture&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a108343143f6e66344798da1bf36609f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a108343143f6e66344798da1bf36609f9">&#9670;&nbsp;</a></span>operator delete()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::operator delete </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>p</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a43e7b3add532f39f40e713c0c53ad53b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43e7b3add532f39f40e713c0c53ad53b">&#9670;&nbsp;</a></span>operator new()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void * <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::operator new </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a546ee39f9b5b6614497835998a7c9ed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a546ee39f9b5b6614497835998a7c9ed2">&#9670;&nbsp;</a></span>pull() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a3e3f89ff8206c0514976b423cb7199cd">BufferRetType</a>&lt; V &gt; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::pull </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>isBufferClosed</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a50bcfe54894b9afe5c944eaeb34969bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50bcfe54894b9afe5c944eaeb34969bd">&#9670;&nbsp;</a></span>pull() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class V &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#a3e3f89ff8206c0514976b423cb7199cd">BufferRetType</a>&lt; V &gt; <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::pull </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>isBufferClosed</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pull a single value from the future buffer. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">BUF</td><td>Represents a class of type <a class="el" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html" title="Container which allows buffered access to a series of values. Values are pushed-in (written) by a pro...">Buffer</a>. </td></tr>
    <tr><td class="paramname">V</td><td>The type of value contained in <a class="el" href="../../d1/d87/classBloomberg_1_1quantum_1_1Buffer.html" title="Container which allows buffered access to a series of values. Values are pushed-in (written) by a pro...">Buffer</a>. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>Pointer to the coroutine synchronization object. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">isBufferClosed</td><td>Indicates if this buffer is closed and no more Pull operations are allowed on it. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The next value pulled out from the front of the buffer. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Method available for buffered futures only. Blocks until one value is retrieved from the buffer. </dd></dl>

<p>Implements <a class="el" href="../../d6/daf/structBloomberg_1_1quantum_1_1ICoroFuture.html#a6764fb2a13c0521db128e0c91e3b9fed">Bloomberg::quantum::ICoroFuture&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a2160d4fb8675845b45923cacfc65e016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2160d4fb8675845b45923cacfc65e016">&#9670;&nbsp;</a></span>valid()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::valid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines if this future still has a shared state with the corresponding promise object. </p>
<dl class="section return"><dt>Returns</dt><dd>True if valid, false otherwise. </dd></dl>

<p>Implements <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#a1fd7859756c7fe5331250197552bd89c">Bloomberg::quantum::ICoroFutureBase</a>.</p>

</div>
</div>
<a id="a2bb3a83f94187b49c6f142379b0ce0d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bb3a83f94187b49c6f142379b0ce0d7">&#9670;&nbsp;</a></span>wait() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::wait </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value. </p>
<dl class="section note"><dt>Note</dt><dd>This method blocks until the future is ready or until an exception is thrown. </dd></dl>

<p>Implements <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#ad9a1edaea33d7ef79e25b89b8c0c056d">Bloomberg::quantum::IThreadFutureBase</a>.</p>

</div>
</div>
<a id="a31f48375fda5b97a9287865f6ae55319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31f48375fda5b97a9287865f6ae55319">&#9670;&nbsp;</a></span>wait() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::wait </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>A pointer to a coroutine synchronization object. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method blocks until the future is ready or until an exception is thrown. </dd></dl>

<p>Implements <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#a75bf5b7070eaaaaaeb21d4484468f93a">Bloomberg::quantum::ICoroFutureBase</a>.</p>

</div>
</div>
<a id="a6e602a8b6fa2df3fbac6b807bb1351fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e602a8b6fa2df3fbac6b807bb1351fb">&#9670;&nbsp;</a></span>waitFor() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::future_status <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::waitFor </td>
          <td>(</td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>timeMs</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value up to a maximum 'timeMs' milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">timeMs</td><td>The maximum amount of milliseconds to wait until the future value becomes ready. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>'ready' if value was posted before duration expired or 'timeout' otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown. </dd></dl>

<p>Implements <a class="el" href="../../d1/d2d/structBloomberg_1_1quantum_1_1IThreadFutureBase.html#a7f0909db9b8a21fb7146cb0cbf4b2af0">Bloomberg::quantum::IThreadFutureBase</a>.</p>

</div>
</div>
<a id="a2674f2183419f724622a6a3ef27fa7b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2674f2183419f724622a6a3ef27fa7b8">&#9670;&nbsp;</a></span>waitFor() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::future_status <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Bloomberg::quantum::Future</a>&lt; T &gt;::waitFor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../d3/d63/structBloomberg_1_1quantum_1_1ICoroSync.html#a109b2c4b7d70d53d48bb640a9d849b29">ICoroSync::Ptr</a>&#160;</td>
          <td class="paramname"><em>sync</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>timeMs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Waits for the future value up to a maximum 'timeMs' milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>A pointer to a coroutine synchronization object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">timeMs</td><td>The maximum amount of milliseconds to wait until the future value becomes ready. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>'ready' if value was posted before duration expired or 'timeout' otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Blocks until the value is ready, until 'timeMs' duration expires or until an exception is thrown. </dd></dl>

<p>Implements <a class="el" href="../../dc/d82/structBloomberg_1_1quantum_1_1ICoroFutureBase.html#af03f1545b1d0cdc90c325627955407b8">Bloomberg::quantum::ICoroFutureBase</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a38b7a1d0cb5a6365a03c19b76293e519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38b7a1d0cb5a6365a03c19b76293e519">&#9670;&nbsp;</a></span>Promise</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<div class="memtemplate">
template&lt;class F &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend <a class="el" href="../../d9/d6d/classclass.html">class</a> <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html">Promise</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html">Future</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
